﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class Hyperlink
   | FastReport OpenSource Class Reference </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class Hyperlink
   | FastReport OpenSource Class Reference ">
    <meta name="generator" content="docfx 2.45.1.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.png" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="FastReport.Hyperlink">
  
  
  <h1 id="FastReport_Hyperlink" data-uid="FastReport.Hyperlink" class="text-break">Class Hyperlink
  </h1>
  <div class="markdown level0 summary"><p>This class contains a hyperlink settings.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">Hyperlink</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="FastReport.html">FastReport</a></h6>
  <h6><strong>Assembly</strong>: FastReport.OpenSource.dll</h6>
  <h5 id="FastReport_Hyperlink_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class Hyperlink</code></pre>
  </div>
  <h3 id="properties">Properties
  </h3>
  
  
  <a id="FastReport_Hyperlink_DetailPageName_" data-uid="FastReport.Hyperlink.DetailPageName*"></a>
  <h4 id="FastReport_Hyperlink_DetailPageName" data-uid="FastReport.Hyperlink.DetailPageName">DetailPageName</h4>
  <div class="markdown level1 summary"><p>Gets or sets the name of this report's page.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string DetailPageName { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_DetailPageName_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use this property if <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_Kind">Kind</a> is set to <strong>DetailPage</strong>. </p>
<p>When you follow the hyperlink, the specified page will be executed. It may contain the
detailed report. You also may specify the report&apos;s parameter in the 
<a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_ReportParameter">ReportParameter</a> property.</p>
</div>
  
  
  <a id="FastReport_Hyperlink_DetailReportName_" data-uid="FastReport.Hyperlink.DetailReportName*"></a>
  <h4 id="FastReport_Hyperlink_DetailReportName" data-uid="FastReport.Hyperlink.DetailReportName">DetailReportName</h4>
  <div class="markdown level1 summary"><p>Gets or sets an external report file name.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string DetailReportName { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_DetailReportName_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use this property if <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_Kind">Kind</a> is set to <strong>DetailReport</strong>. </p>
<p>When you follow the hyperlink, this report will be loaded and run. 
You also may specify the report&apos;s parameter in the <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_ReportParameter">ReportParameter</a> property.</p>
</div>
  
  
  <a id="FastReport_Hyperlink_Expression_" data-uid="FastReport.Hyperlink.Expression*"></a>
  <h4 id="FastReport_Hyperlink_Expression" data-uid="FastReport.Hyperlink.Expression">Expression</h4>
  <div class="markdown level1 summary"><p>Gets or sets the expression which value will be used for navigation.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Expression { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_Expression_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Normally you should set the <strong>Expression</strong> property to
any valid expression that will be calculated when this object is about to print.
The value of an expression will be used for navigation.</p>
<p>If you want to navigate to some fixed data (URL or page number, for example),
use the <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_Value">Value</a> property instead.</p>
</div>
  
  
  <a id="FastReport_Hyperlink_Kind_" data-uid="FastReport.Hyperlink.Kind*"></a>
  <h4 id="FastReport_Hyperlink_Kind" data-uid="FastReport.Hyperlink.Kind">Kind</h4>
  <div class="markdown level1 summary"><p>Gets or sets the kind of hyperlink.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public HyperlinkKind Kind { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="FastReport.HyperlinkKind.html">HyperlinkKind</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_Kind_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use the <strong>Kind</strong> property to define hyperlink&apos;s behavior. 
The hyperlink may be used to navigate to the external url, the page number, 
the bookmark defined by other report object, the external report, the other page of this report, 
and custom hyperlink.</p>
</div>
  
  
  <a id="FastReport_Hyperlink_OpenLinkInNewTab_" data-uid="FastReport.Hyperlink.OpenLinkInNewTab*"></a>
  <h4 id="FastReport_Hyperlink_OpenLinkInNewTab" data-uid="FastReport.Hyperlink.OpenLinkInNewTab">OpenLinkInNewTab</h4>
  <div class="markdown level1 summary"><p>Gets or sets a value that indicate should be links open in new tab or not.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool OpenLinkInNewTab { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_OpenLinkInNewTab_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>It works for HTML-export only!</p>
</div>
  
  
  <a id="FastReport_Hyperlink_ReportParameter_" data-uid="FastReport.Hyperlink.ReportParameter*"></a>
  <h4 id="FastReport_Hyperlink_ReportParameter" data-uid="FastReport.Hyperlink.ReportParameter">ReportParameter</h4>
  <div class="markdown level1 summary"><p>Gets or sets a parameter's name that will be set to hyperlink's value.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string ReportParameter { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_ReportParameter_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use this property if <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_Kind">Kind</a> is set to <strong>DetailReport</strong> or <strong>DetailPage</strong>.</p>
<p>If you want to pass the hyperlink&apos;s value to the report&apos;s parameter, specify the
parameter name in this property. This parameter will be set to the hyperlink&apos;s value 
before running a report. It may be used to display detailed information about clicked item.</p>
<p>It is also possible to pass multiple values to several parameters. If hyperlink&apos;s value
contains separators (the separator string can be set in the <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_ValuesSeparator">ValuesSeparator</a>
property), it will be splitted to several values. That values will be passed to nested parameters
of the <strong>ReportParameter</strong> (you should create nested parameters by youself). For example, you have
the <strong>ReportParameter</strong> called &quot;SelectedValue&quot; which has two nested parameters: the first one is 
&quot;Employee&quot; and the second is &quot;Category&quot;. The hyperlink&apos;s value is &quot;Andrew Fuller;Beverages&quot;. 
It will be splitted to two values: &quot;Andrew Fuller&quot; and &quot;Beverages&quot;. The first nested parameter 
of the <strong>ReportParameter</strong> that is &quot;Employee&quot; in our case will be set to &quot;Andrew Fuller&quot;;
the second nested parameter (&quot;Category&quot;) will be set to &quot;Beverages&quot;.</p>
<p>Note: when you create a parameter in the detailed report, don&apos;t forget to set 
its <strong>DataType</strong> property. It is used to convert string values to actual data type.
</p>
</div>
  
  
  <a id="FastReport_Hyperlink_Value_" data-uid="FastReport.Hyperlink.Value*"></a>
  <h4 id="FastReport_Hyperlink_Value" data-uid="FastReport.Hyperlink.Value">Value</h4>
  <div class="markdown level1 summary"><p>Gets or sets a value that will be used for navigation.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Value { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="FastReport_Hyperlink_Value_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use this property to specify the fixed data (such as URL, page number etc). If you want to
navigate to some dynamically calculated value, use the <a class="xref" href="FastReport.Hyperlink.html#FastReport_Hyperlink_Expression">Expression</a> property instead.</p>
</div>
  
  
  <a id="FastReport_Hyperlink_ValuesSeparator_" data-uid="FastReport.Hyperlink.ValuesSeparator*"></a>
  <h4 id="FastReport_Hyperlink_ValuesSeparator" data-uid="FastReport.Hyperlink.ValuesSeparator">ValuesSeparator</h4>
  <div class="markdown level1 summary"><p>Gets or sets a string that will be used as a separator to pass several values
to the external report parameters.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string ValuesSeparator { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  
  
  <a id="FastReport_Hyperlink_Assign_" data-uid="FastReport.Hyperlink.Assign*"></a>
  <h4 id="FastReport_Hyperlink_Assign_FastReport_Hyperlink_" data-uid="FastReport.Hyperlink.Assign(FastReport.Hyperlink)">Assign(Hyperlink)</h4>
  <div class="markdown level1 summary"><p>Assigns values from another source.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Assign(Hyperlink source)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="FastReport.Hyperlink.html">Hyperlink</a></td>
        <td><span class="parametername">source</span></td>
        <td><p>Source to assign from.</p>
</td>
      </tr>
    </tbody>
  </table>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
